Skip to main content

dropboxDelete

Type​

command

Summary​

Delete the file or folder at a given path.

Syntax​

dropboxDelete <pAccessToken>, <pPath>, [<pCallback>]

Description​

If the path is a folder, all its contents will be deleted too. A successful response indicates that the file or folder was deleted. The returned metadata will be the corresponding FileMetadata or FolderMetadata for the item at time of deletion, and not a DeletedMetadata object.

If the callback parameter is not empty the request will be asynchronus and when complete the callback will be sent to the object that accessed the API. The callback will be sent with three parameters:

  • The request ID which will be the value of the it variable after calling the command
  • The HTTP response code
  • The data returned which will be the same data as documented for the it variable in a synchronous request.

Parameters​

NameTypeDescription

pAccessToken

An OAuth2 Access token to access the user's account

pPath

Path in the user's Dropbox to be deleted.

pCallback

The handler to call when the request is complete. If empty the command will block until complete.